home *** CD-ROM | disk | FTP | other *** search
/ Apple Developer Connection 1998 Fall: Game Toolkit / Disc.iso / SDKs / QuickTime Mac / AIncludes / QD3DStorage.a < prev    next >
Encoding:
Text File  |  1998-04-09  |  9.3 KB  |  327 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        QD3DStorage.a
  3. ;
  4. ;    Contains:    Abstraction to deal with various types of stream-based storage devices        
  5. ;
  6. ;    Version:    Technology:    Quickdraw 3D 1.5.4
  7. ;                Release:    QuickTime 3.0
  8. ;
  9. ;    Copyright:    © 1995-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__QD3DSTORAGE__') = 'UNDEFINED' THEN
  19. __QD3DSTORAGE__ SET 1
  20.  
  21.     IF &TYPE('__QD3D__') = 'UNDEFINED' THEN
  22.     include 'QD3D.a'
  23.     ENDIF
  24.  
  25.     IF TARGET_OS_MAC THEN
  26.     IF &TYPE('__MACTYPES__') = 'UNDEFINED' THEN
  27.     include 'MacTypes.a'
  28.     ENDIF
  29.     IF &TYPE('__FILES__') = 'UNDEFINED' THEN
  30.     include 'Files.a'
  31.     ENDIF
  32.     ENDIF    ; TARGET_OS_MAC
  33. ; ******************************************************************************
  34. ; **                                                                             **
  35. ; **                                Storage Routines                             **
  36. ; **                                                                             **
  37. ; ****************************************************************************
  38.  
  39. ;
  40. ; extern TQ3ObjectType Q3Storage_GetType(TQ3StorageObject storage)
  41. ;
  42.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  43.         IMPORT_CFM_FUNCTION Q3Storage_GetType
  44.     ENDIF
  45.  
  46. ;
  47. ; extern TQ3Status Q3Storage_GetSize(TQ3StorageObject storage, unsigned long *size)
  48. ;
  49.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  50.         IMPORT_CFM_FUNCTION Q3Storage_GetSize
  51.     ENDIF
  52.  
  53. ;  
  54. ; *    Reads "dataSize" bytes starting at offset in storage, copying into data. 
  55. ; *    sizeRead returns the number of bytes filled in. 
  56. ; *    
  57. ; *    You may assume if *sizeRead < dataSize, then EOF is at offset + *sizeRead
  58. ; 
  59.  
  60. ;
  61. ; extern TQ3Status Q3Storage_GetData(TQ3StorageObject storage, unsigned long offset, unsigned long dataSize, unsigned char *data, unsigned long *sizeRead)
  62. ;
  63.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  64.         IMPORT_CFM_FUNCTION Q3Storage_GetData
  65.     ENDIF
  66.  
  67. ;  
  68. ; *    Write "dataSize" bytes starting at offset in storage, copying from data. 
  69. ; *    sizeWritten returns the number of bytes filled in. 
  70. ; *    
  71. ; *    You may assume if *sizeRead < dataSize, then EOF is at offset + *sizeWritten
  72. ; 
  73.  
  74. ;
  75. ; extern TQ3Status Q3Storage_SetData(TQ3StorageObject storage, unsigned long offset, unsigned long dataSize, const unsigned char *data, unsigned long *sizeWritten)
  76. ;
  77.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  78.         IMPORT_CFM_FUNCTION Q3Storage_SetData
  79.     ENDIF
  80.  
  81. ; ******************************************************************************
  82. ; **                                                                             **
  83. ; **                             Memory Storage Prototypes                         **
  84. ; **                                                                             **
  85. ; ****************************************************************************
  86.  
  87. ;
  88. ; extern TQ3ObjectType Q3MemoryStorage_GetType(TQ3StorageObject storage)
  89. ;
  90.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  91.         IMPORT_CFM_FUNCTION Q3MemoryStorage_GetType
  92.     ENDIF
  93.  
  94. ; 
  95. ; * These calls COPY the buffer into QD3D space
  96. ; 
  97.  
  98. ;
  99. ; extern TQ3StorageObject Q3MemoryStorage_New(const unsigned char *buffer, unsigned long validSize)
  100. ;
  101.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  102.         IMPORT_CFM_FUNCTION Q3MemoryStorage_New
  103.     ENDIF
  104.  
  105. ;
  106. ; extern TQ3Status Q3MemoryStorage_Set(TQ3StorageObject storage, const unsigned char *buffer, unsigned long validSize)
  107. ;
  108.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  109.         IMPORT_CFM_FUNCTION Q3MemoryStorage_Set
  110.     ENDIF
  111.  
  112. ; 
  113. ; * These calls use the pointer given - you must dispose it when you're through
  114. ; 
  115.  
  116. ;
  117. ; extern TQ3StorageObject Q3MemoryStorage_NewBuffer(unsigned char *buffer, unsigned long validSize, unsigned long bufferSize)
  118. ;
  119.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  120.         IMPORT_CFM_FUNCTION Q3MemoryStorage_NewBuffer
  121.     ENDIF
  122.  
  123. ;
  124. ; extern TQ3Status Q3MemoryStorage_SetBuffer(TQ3StorageObject storage, unsigned char *buffer, unsigned long validSize, unsigned long bufferSize)
  125. ;
  126.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  127.         IMPORT_CFM_FUNCTION Q3MemoryStorage_SetBuffer
  128.     ENDIF
  129.  
  130. ;
  131. ; extern TQ3Status Q3MemoryStorage_GetBuffer(TQ3StorageObject storage, unsigned char **buffer, unsigned long *validSize, unsigned long *bufferSize)
  132. ;
  133.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  134.         IMPORT_CFM_FUNCTION Q3MemoryStorage_GetBuffer
  135.     ENDIF
  136.  
  137.     IF TARGET_OS_MAC THEN
  138. ; ******************************************************************************
  139. ; **                                                                             **
  140. ; **                                Macintosh Handles Prototypes                 **
  141. ; **                                                                             **
  142. ; ****************************************************************************
  143.  
  144. ;  Handle Storage is a subclass of Memory Storage 
  145. ;
  146. ; extern TQ3StorageObject Q3HandleStorage_New(Handle handle, unsigned long validSize)
  147. ;
  148.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  149.         IMPORT_CFM_FUNCTION Q3HandleStorage_New
  150.     ENDIF
  151.  
  152. ;
  153. ; extern TQ3Status Q3HandleStorage_Set(TQ3StorageObject storage, Handle handle, unsigned long validSize)
  154. ;
  155.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  156.         IMPORT_CFM_FUNCTION Q3HandleStorage_Set
  157.     ENDIF
  158.  
  159. ;
  160. ; extern TQ3Status Q3HandleStorage_Get(TQ3StorageObject storage, Handle *handle, unsigned long *validSize)
  161. ;
  162.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  163.         IMPORT_CFM_FUNCTION Q3HandleStorage_Get
  164.     ENDIF
  165.  
  166. ; ******************************************************************************
  167. ; **                                                                             **
  168. ; **                                Macintosh Storage Prototypes                 **
  169. ; **                                                                             **
  170. ; ****************************************************************************
  171.  
  172. ;
  173. ; extern TQ3StorageObject Q3MacintoshStorage_New(short fsRefNum)
  174. ;
  175.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  176.         IMPORT_CFM_FUNCTION Q3MacintoshStorage_New
  177.     ENDIF
  178.  
  179. ;  Note: This storage is assumed open 
  180. ;
  181. ; extern TQ3Status Q3MacintoshStorage_Set(TQ3StorageObject storage, short fsRefNum)
  182. ;
  183.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  184.         IMPORT_CFM_FUNCTION Q3MacintoshStorage_Set
  185.     ENDIF
  186.  
  187. ;
  188. ; extern TQ3Status Q3MacintoshStorage_Get(TQ3StorageObject storage, short *fsRefNum)
  189. ;
  190.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  191.         IMPORT_CFM_FUNCTION Q3MacintoshStorage_Get
  192.     ENDIF
  193.  
  194. ;
  195. ; extern TQ3ObjectType Q3MacintoshStorage_GetType(TQ3StorageObject storage)
  196. ;
  197.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  198.         IMPORT_CFM_FUNCTION Q3MacintoshStorage_GetType
  199.     ENDIF
  200.  
  201.  
  202. ; ******************************************************************************
  203. ; **                                                                             **
  204. ; **                            Macintosh FSSpec Storage Prototypes                 **
  205. ; **                                                                             **
  206. ; ****************************************************************************
  207.  
  208. ;
  209. ; extern TQ3StorageObject Q3FSSpecStorage_New(const FSSpec *fs)
  210. ;
  211.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  212.         IMPORT_CFM_FUNCTION Q3FSSpecStorage_New
  213.     ENDIF
  214.  
  215. ;
  216. ; extern TQ3Status Q3FSSpecStorage_Set(TQ3StorageObject storage, const FSSpec *fs)
  217. ;
  218.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  219.         IMPORT_CFM_FUNCTION Q3FSSpecStorage_Set
  220.     ENDIF
  221.  
  222. ;
  223. ; extern TQ3Status Q3FSSpecStorage_Get(TQ3StorageObject storage, FSSpec *fs)
  224. ;
  225.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  226.         IMPORT_CFM_FUNCTION Q3FSSpecStorage_Get
  227.     ENDIF
  228.  
  229.     ENDIF    ; TARGET_OS_MAC
  230.     IF TARGET_OS_WIN32 THEN
  231. ; ******************************************************************************
  232. ; **                                                                             **
  233. ; **                            Win32 HANDLE Storage Prototypes                     **
  234. ; **                                                                             **
  235. ; ****************************************************************************
  236.  
  237. ;
  238. ; extern TQ3StorageObject Q3Win32Storage_New(HANDLE hFile)
  239. ;
  240.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  241.         IMPORT_CFM_FUNCTION Q3Win32Storage_New
  242.     ENDIF
  243.  
  244. ;
  245. ; extern TQ3Status Q3Win32Storage_Set(TQ3StorageObject storage, HANDLE hFile)
  246. ;
  247.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  248.         IMPORT_CFM_FUNCTION Q3Win32Storage_Set
  249.     ENDIF
  250.  
  251. ;
  252. ; extern TQ3Status Q3Win32Storage_Get(TQ3StorageObject storage, HANDLE *hFile)
  253. ;
  254.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  255.         IMPORT_CFM_FUNCTION Q3Win32Storage_Get
  256.     ENDIF
  257.  
  258.     ENDIF    ; TARGET_OS_WIN32
  259.  
  260. ; ******************************************************************************
  261. ; **                                                                             **
  262. ; **                                    Unix Prototypes                             **
  263. ; **                                                                             **
  264. ; ****************************************************************************
  265.  
  266. ;
  267. ; extern TQ3StorageObject Q3UnixStorage_New(FILE *storage)
  268. ;
  269.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  270.         IMPORT_CFM_FUNCTION Q3UnixStorage_New
  271.     ENDIF
  272.  
  273. ;
  274. ; extern TQ3Status Q3UnixStorage_Set(TQ3StorageObject storage, FILE *stdFile)
  275. ;
  276.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  277.         IMPORT_CFM_FUNCTION Q3UnixStorage_Set
  278.     ENDIF
  279.  
  280. ;
  281. ; extern TQ3Status Q3UnixStorage_Get(TQ3StorageObject storage, FILE **stdFile)
  282. ;
  283.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  284.         IMPORT_CFM_FUNCTION Q3UnixStorage_Get
  285.     ENDIF
  286.  
  287. ;
  288. ; extern TQ3ObjectType Q3UnixStorage_GetType(TQ3StorageObject storage)
  289. ;
  290.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  291.         IMPORT_CFM_FUNCTION Q3UnixStorage_GetType
  292.     ENDIF
  293.  
  294. ; ******************************************************************************
  295. ; **                                                                             **
  296. ; **                                Unix Path Prototypes                         **
  297. ; **                                                                             **
  298. ; ****************************************************************************
  299.  
  300. ;
  301. ; extern TQ3StorageObject Q3UnixPathStorage_New(const char *pathName)
  302. ;
  303.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  304.         IMPORT_CFM_FUNCTION Q3UnixPathStorage_New
  305.     ENDIF
  306.  
  307. ;  C string 
  308. ;
  309. ; extern TQ3Status Q3UnixPathStorage_Set(TQ3StorageObject storage, const char *pathName)
  310. ;
  311.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  312.         IMPORT_CFM_FUNCTION Q3UnixPathStorage_Set
  313.     ENDIF
  314.  
  315. ;  C string 
  316. ;
  317. ; extern TQ3Status Q3UnixPathStorage_Get(TQ3StorageObject storage, char *pathName)
  318. ;
  319.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  320.         IMPORT_CFM_FUNCTION Q3UnixPathStorage_Get
  321.     ENDIF
  322.  
  323. ;  pathName is a buffer 
  324.  
  325.     ENDIF ; __QD3DSTORAGE__ 
  326.  
  327.